chore(phpstan): require comments on inline @phpstan-ignore annotations#482
Merged
Merged
Conversation
Enable reportIgnoresWithoutComments so every inline suppression documents why it is safe to ignore. No existing inline ignores in src/ or migrations/, so the analysis stays green. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Enables PHPStan's
reportIgnoresWithoutCommentsparameter so every inline@phpstan-ignoreannotation must carry a(comment)explaining the suppression. Adopts the convention already in place in itk-dev/openid-connect-bundle.Features Added
// @phpstan-ignore identifier (reason).@phpstan-ignoreannotations exist insrc/ormigrations/today, so this purely enforces discipline on future suppressions. The generatedphpstan-baseline.neonis unaffected.Files Changed
phpstan.dist.neon- addedreportIgnoresWithoutComments: truewith explanatory commentCHANGELOG.md- entry under[Unreleased]Test Plan
task code-analysis→[OK] No errors(verified locally)// @phpstan-ignore somethingto any file undersrc/and observe PHPStan fail with a missing-comment error🤖 Generated with Claude Code